Skip to content

Add --suites filter to generate_reference_results#728

Merged
MakisH merged 7 commits into
precice:developfrom
Geethapranay1:fix/issue-711
May 12, 2026
Merged

Add --suites filter to generate_reference_results#728
MakisH merged 7 commits into
precice:developfrom
Geethapranay1:fix/issue-711

Conversation

@Geethapranay1
Copy link
Copy Markdown
Contributor

@Geethapranay1 Geethapranay1 commented Feb 27, 2026

Closes #711

Changes

  1. tools/tests/generate_reference_results.py — added --suites argument (comma-separated, optional) to filter which test suites to generate reference results for. When not provided, all suites run (backward compatible).
  2. generate_reference_results_workflow.yml — added optional suites input. When provided, passes --suites to the script and uses selective git add --update to only commit modified files. When empty, behavior is unchanged.
  3. generate_reference_results_manual.yml — added suites input field for the manual trigger UI.

Testing

1. full docker test passed for --suites filter
Screenshot From 2026-02-26 17-56-26

only 3 elastic tube tests ran not all 10

2. error handling for invalid suite name
image

3. backward compatible default behavior (no --suites)
Screenshot From 2026-02-26 18-09-55

4. --help shows a new argument
image

Checklist:

  • I added a summary of any user-facing changes (compared to the last release) in the changelog-entries/<711>.md.
  • I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

@Geethapranay1
Copy link
Copy Markdown
Contributor Author

hi @MakisH
this pr solves the #711 issue.
check once and let me know if any further requirements needed in the pr.

@MakisH MakisH added GSoC Contributed in the context of the Google Summer of Code systemtests labels Feb 27, 2026
Copy link
Copy Markdown
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for contributing! This is useful, especially since I would now restructure our test.yaml based on more granular test cases (#767).

I tested it locally, and it works as expected. Just one comment on an error message, which should be easy to fix (I can also just fix it directly).

I am also requesting a Copilot review mostly out of curiosity.

Comment thread tools/tests/generate_reference_results.py Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an optional test-suite filter to the reference-results generation tooling and workflows, so maintainers can regenerate reference results for only selected suites (instead of always rebuilding all archives).

Changes:

  • Added --suites (comma-separated) to tools/tests/generate_reference_results.py to filter which suites are processed.
  • Extended the reusable workflow and the manual workflow-dispatch UI to accept an optional suites input and forward it to the script.
  • Updated the workflow’s staging logic to avoid broadly re-adding all reference result archives when a filter is used.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
tools/tests/generate_reference_results.py Introduces --suites filtering logic for selecting a subset of test suites.
.github/workflows/generate_reference_results_workflow.yml Adds suites input, passes it to the generator, and changes staging behavior for filtered runs.
.github/workflows/generate_reference_results_manual.yml Adds a suites input to the manual trigger and forwards it to the reusable workflow.
changelog-entries/711.md Documents the new optional suites filter for reference result generation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tools/tests/generate_reference_results.py Outdated
Comment thread .github/workflows/generate_reference_results_workflow.yml Outdated
Comment thread .github/workflows/generate_reference_results_workflow.yml Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Comment thread .github/workflows/generate_reference_results_workflow.yml Outdated
Comment thread .github/workflows/generate_reference_results_workflow.yml Outdated
Comment thread tools/tests/generate_reference_results.py Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comment thread .github/workflows/generate_reference_results_workflow.yml Outdated
Comment thread changelog-entries/711.md
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread .github/workflows/generate_reference_results_workflow.yml
@MakisH MakisH merged commit 1d38261 into precice:develop May 12, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSoC Contributed in the context of the Google Summer of Code systemtests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Workflow to generate reference results always updates all cases

3 participants